Skip to main content

Set-IMLibrary

SYNOPSIS​

Updates an Immich library configuration.

SYNTAX​

Set-IMLibrary [[-Session] <ImmichSession>] [-Id] <String[]> [[-ExclusionPatterns] <String[]>]
 [[-ImportPaths] <String[]>] [[-Name] <String>] [-ProgressAction <ActionPreference>] [-WhatIf] [-Confirm]
 [<CommonParameters>]

DESCRIPTION​

The Set-IMLibrary function updates an existing Immich library with new configuration settings. You can modify the library name, visibility, import paths, and exclusion patterns. This function supports pipeline input for batch updates and includes confirmation prompts for safety when making changes to library configurations.

EXAMPLES​

EXAMPLE 1​

Set-IMLibrary -Id 'bf973405-3f2a-48d2-a687-2ed4167164be' -Name 'Family Photos'

Updates the library with the specified ID to have the name 'Family Photos'.

EXAMPLE 2​

Set-IMLibrary -Id 'bf973405-3f2a-48d2-a687-2ed4167164be' -IsVisible $false

Hides the specified library from the Immich interface by setting visibility to false.

EXAMPLE 3​

$library | Set-IMLibrary -Name 'Updated Library' -ImportPaths @('/photos', '/videos')

Updates a library object from the pipeline with a new name and import paths.

EXAMPLE 4​

Get-IMLibrary | Where-Object Name -like '*temp*' | Set-IMLibrary -IsVisible $false

Hides all libraries with 'temp' in their name using pipeline processing.

PARAMETERS​

-Session​

Optionally define a immich session object to use. This is useful when you are connected to more than one immich instance.

-Session $Session

Type: ImmichSession
Parameter Sets: (All)
Aliases:

Required: False
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Id​

Specifies the unique identifier of the library to update. Must be a valid GUID format. Accepts pipeline input by value and by property name for batch operations.

Type: String[]
Parameter Sets: (All)
Aliases:

Required: True
Position: 2
Default value: None
Accept pipeline input: True (ByPropertyName, ByValue)
Accept wildcard characters: False

-ExclusionPatterns​

Defines file and folder exclusion patterns for the library. These patterns determine which files and directories should be ignored during library scanning operations.

Type: String[]
Parameter Sets: (All)
Aliases:

Required: False
Position: 3
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-ImportPaths​

Specifies the file system paths that the library should monitor and import assets from. Multiple paths can be specified for comprehensive coverage.

Type: String[]
Parameter Sets: (All)
Aliases:

Required: False
Position: 4
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Name​

Specifies the new display name for the library. This name appears in the Immich interface and helps identify the library's purpose or content type.

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 5
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-WhatIf​

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: wi

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Confirm​

Prompts you for confirmation before running the cmdlet.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-ProgressAction​

{{ Fill ProgressAction Description }}

Type: ActionPreference
Parameter Sets: (All)
Aliases: proga

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters​

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS​

OUTPUTS​

NOTES​

This function supports ShouldProcess for confirmation prompts when making changes. Use -WhatIf to preview changes before applying them to library configurations.

EDIT THIS DOC​

This page was auto-generated from the powershell command comment based help. To edit the content of this page, update the script file comment based help on github Github